﻿README.txt  


Project Name: Serene / Self-Care Companion  
Hosted On: Firebase Hosting  
Authors: Harold Luis, Gabriel Reyes, Jessica Estevez, Jessica Jeanty, Diana Matus  
Date: August 4, 2025


Description:
-------------
Serene is a calming self-care web app that helps users manage their wellness with breathing exercises, hydration reminders, and journaling. It also includes a login system powered by Firebase, optional premium features, and a serene design interface.


Directory Structure:
---------------------


.
└── haroldluis09.github.io/
    ├── index.html
    ├── login.html
    ├── free.hmtl
    ├── dashboard.html
    ├── about.html
    ├── meditation.html
    ├── premium.html
    ├── Calmbreathing.html
    ├── digitaldetox.html
    ├── Gratitude.html
    ├── help_contact.html
    ├── journal.html
    ├── sleepaid.html
    ├── stretch.html
    ├── wrtiedata.html
    ├── script.js
    └── documentation.docx/
        ├── hydrationapp/
        │   ├── hydrate.html
        │   ├── script.js
        │   ├── style.css
        │   └── waterfall.mp3
        └── images/mp3/
            ├── SereneLogo.PNG
            ├── background.PNG
            ├── boats.jpg
            ├── try.jpeg
            ├── meditation.jpg
            ├── SereneS.png
            ├── breathingwoman.mp4
            └── humming.mp3
Notes:
-------
- The login system is powered by Firebase Authentication.
- Hosting is done through Firebase Hosting.
- All premium content is protected behind authentication.
- No sensitive backend or server logic is exposed.


Installation Guide for Serene  
==============================


1. Install Firebase Tools:
--------------------------
If not already installed, open your terminal and run:


npm install -g firebase-tools


Then login to Firebase:
firebase login


2. Clone or Prepare Your Project Folder:
----------------------------------------
Place all your site files (e.g., login.html, about.html, etc.) in a folder named "public".


3. Initialize Firebase Hosting:
-------------------------------
Inside your project directory:


firebase init


- Select "Hosting"
- Choose the existing Firebase project (serene-interface)
- Set "public" as the public directory
- Choose "No" for single-page app (unless using one)
- Choose "No" for overwriting index.html if already exists


4. Deploy to Firebase:
----------------------
firebase deploy


You will get a hosting URL after deployment.


5. Firebase Configuration:
--------------------------
In your `login.html`, the Firebase config block already exists:
const firebaseConfig = {
apiKey: "...",
authDomain: "...",
...
};
This must remain unchanged for your Firebase app to work.


6. Firebase Authentication Setup:
---------------------------------
In the Firebase Console:
- Go to "Authentication" > "Sign-in method"
- Enable "Email/Password"


7. Firebase Storage (optional):
-------------------------------
If you use user-generated content (e.g., journal entries), enable Firebase, Firestore, or Realtime Database.


---


Optional:
---------
To view your site locally before deploying:


firebase serve


Serene User Manual  
==================


Overview:
---------
Serene is your digital wellness assistant. It helps users find moments of calm through guided breathing, journaling, and daily mindfulness. Users can log in, use free features, or unlock premium experiences.


Navigation:
-----------
-**index.html**: Home page and allows user to login or sign up.
- **login.html**: Login with email & password.
- **free.html**: Register for a new free account.
- **dashboard.html**: Your wellness hub after login.
- **about.html**: Info, support contact, and privacy practices.
-**meditation.html**: Choose between calm breathing, gratitude, and sleep aid.
- **Calmbreathing.html**: Breathing animation to guide calming sessions.
-**digitaldetox.hmtl**: Timer and a tracker to make digital detox’s simple.
-**gratitude.hmtl**: Reflect on the things you are grateful for.
-**helpcontact.html**: Contact the Serene offices for any help.
-**journal.html**: Create a daily journal and write about your day-to-day experiences.
-**sleepaid.html**: Short excerpts explaining proper ways to relax and fall asleep.
-**stretch.html**: Simple stretches to make you and your body feel better.
- **premium.html**: Explore the benefits of Serene Premium.


Premium Features:
-----------------
* No ads
* Full access to Serene Library
* Offline mode
* Live meditation session with trainer
* Exclusive exercises
* Free coaching lessons


Using the App:
--------------
1. Visit `haroldlus09.github.io’.
2. Login with your email and password.
3. Choose a ritual (e.g., Calm Breathing, Journal, Stretching, etc.)
4. Navigate to Premium for upgrade info.
5. Use sidebar menu (☰) or dashboard to switch pages.


Support:
--------
- Forgot password? Visit About page for recovery info
- Contact: sereneapp@email.com
- Phone Support: (555) 123-4567


Privacy:
--------
- Your content is encrypted in transit
- Only you can view your data
- We never share or sell your information